Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add new radio text event #742

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Steinertech9
Copy link
Contributor

adds a new event for changing the live encoder for radio

@Steinertech9 Steinertech9 added documentation Improvements or additions to documentation feature New feature or request javascript Pull requests that update Javascript code safe to test Only apply to PRs when test runs should be executed labels Jan 8, 2025
@Steinertech9 Steinertech9 self-assigned this Jan 8, 2025
@Steinertech9 Steinertech9 force-pushed the dev/735-new-event-type-deardeventhubv1radiotext-for-possible-encoder-integration branch from 4259fd3 to e19a1aa Compare January 8, 2025 14:14
@Steinertech9 Steinertech9 requested a review from frytg January 8, 2025 14:15
@saerdnaer
Copy link
Contributor

saerdnaer commented Jan 10, 2025

Could you also add example messages from #735 like at https://swrlab.github.io/ard-eventhub/#/docs/TYPES (which we probably also link in https://swrlab.github.io/ard-eventhub/#/docs/EVENTS)

@frytg frytg assigned frytg and unassigned Steinertech9 Jan 21, 2025
Copy link
Member

@frytg frytg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and we should add a full POST example to the docs as @saerdnaer suggested (#742 (comment))

also, we could use 1.10.0 as version

openapi.yaml Outdated
The subset is defined in the list of required fields of Schemas `eventV1PostRadioTextBody`, resulting in this body:
```json
{
"event": "music",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

event should be de.ard.eventhub.v1.radio.text

{
"event": "music",
"start": "2020-01-19T06:00:00+01:00",
"validUntil": "2026-01-19T06:00:00+01:00",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

validUntil example should be greater than start?


// add a different suffix for radio text topics to not confuse subscribers with new event
if (req.body.event === 'de.ard.eventhub.v1.radio.text') {
urnPrefix = `RadioText:${urnPrefix}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this breaks the otherweise fairly lowercase spelling
{"id":"RadioText:urn:ard:permanent-livestream:a315d3e482f09e1b","messageId":"13323640311135945","name":"de.ard.eventhub.dev.RadioText%3Aurn%3Aard%3Apermanent-livestream%3Aa315d3e482f09e1b","status":"MESSAGE_SENT"}

maybe radio-text?

@frytg frytg assigned Steinertech9 and unassigned frytg Jan 23, 2025
@Steinertech9 Steinertech9 requested a review from frytg January 28, 2025 02:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature New feature or request javascript Pull requests that update Javascript code safe to test Only apply to PRs when test runs should be executed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New event type de.ard.eventhub.v1.radio.text for possible encoder integration
3 participants